Edit Task: RecurringPeriodicWindows
Format
SCHED / EditTask '<TaskName>' RecurringPeriodicWindows <# Periodic Definitions> <Frequency1Start> <Frequency1Stop> <PerPeriodPerWindow> <Repeats> <PriorityDelta> <Epoch (custom only)> <Interval (custom only)> '<Period1Comment>' <# Inside Windows> <Per1Widnow1Offset> <Per1Window1Duration> '<Per1Window1Comment>' ... <Per1WindowNOffset> <Per1WindowNDuration> '<Per1WindowNComment>' ... <PeriodicDefinitionN>
Description
The RecurringPeriodicWindows attribute under EditTask defines a number of recurring periodic windows for the task. This attribute should only be used if the attribute RecurringType is set to RecurringTime. Any previous periodic windows are deleted. For more information on parameters, see the description of the Periodic Window Definition Form.
Parameters
Parameter | Description |
---|---|
# Periodic Definitions | An integer value indicating the number of periodic definitions that are contained within the command. |
Frequency | Options are Yearly, Monthly, Weekly, Daily, Hourly, Minutely, and Custom. |
Start/Stop | The format is YYYY/MM/DD_HH:MM:SS or YYYY/MM/DD_HH:MM:SS.fff. |
PerPeriodPerWindow | Options are either PerPeriod or PerWindow. |
Repeats | A positive integer value representing the number of duplicate tasks that should be made for this window definition. |
PriorityDelta | An integer value that represents a difference between the task's priority and the priority of the current periodic window definition. The value can be either positive of negative. The delta is incrementally applied to each repeat created (ex. if Task1 priority = 1 and the delta is 2 with 3 repeats specified, the first child task's priority would be 1, the second child task's priority = 3, and the third child task's priority = 5). |
Epoch (custom only) | The parameter should only be used if the Frequency is set to Custom. The parameter should be entered in the format -- YYYY/MM/DD_HH:MM:SS or YYYY/MM/DD_HH:MM:SS.fff. |
Interval (custom only) | The parameter should only be used if the Frequency is set to Custom. The parameter should be a number representing seconds (millisecond fidelity). |
Comments | A string of text in single quotes of the comment for the given periodic window. |
# Inside Windows | An integer value that is required and may be zero if there are no definitions within the window. If the parameter value is zero, PerNWindow parameters should not be included. |
PerNWindowNOffset |
The parameter value format is based on the format of the frequency: Weekly: DD_HH:MM:SS.fff (e.g. TU_10:04:05.100) |
PerNWindowNDuration | Enter as a number in seconds (millisecond fidelity). |
PerNWindowNComment | A string of text in single quotes of the comment for the given inside window. |
Examples
Set a yearly recurring window that occurs 3 times every Jan 1, with a duration of 1000 seconds
SCHED / EditTask 'TaskA' RecurringPeriodicWindows 1 Yearly 2015/01/01_00:00:00 2015/01/03_00:00:00 PerPeriod 3 0 '' 1 01/01_12:30:00 100 ''
Set a monthly recurring window that occurs twice every 1st of the month, with a priority delta of -2
SCHED / EditTask 'TaskA' RecurringPeriodicWindows 1 Monthly 2015/01/01_00:00:00 2015/01/03_00:00:00 PerPeriod 2 -2 '' 1 1_00:00:00 100 ''
Set a weekly recurring window that occurs twice every Friday, with a duration of 120 seconds
SCHED / EditTask 'TaskA' RecurringPeriodicWindows 1 Weekly 2015/01/01_00:00:00 2015/01/03_00:00:00 PerPeriod 2 0 '' 1 Fr_00:00:00.00 120 ''
Set a daily recurring window for a task, with a subwindow that occurs 34200 seconds after the start of each day.
SCHED / EditTask 'TaskA' RecurringPeriodicWindows 1 Daily 2015/01/01_00:00:00 2015/01/03_00:00:00 PerPeriod 1 0 '' 1 34200 1200 ''
Add hourly recurring windows to a task.
SCHED / EditTask 'TaskA' RecurringPeriodicWindows 1 Hourly 2015/01/01_00:00:00 2015/01/03_00:00:00 PerPeriod 1 0 '' 1 00:05:00.000 600 ''
Add minutely recurring windows to a task.
SCHED / EditTask 'TaskA' RecurringPeriodicWindows 1 Minutely 2015/01/01_00:00:00 2015/01/03_00:00:00 PerPeriod 1 0 '' 0
Set a custom 2 day window for a task, with no subwindows.
SCHED / EditTask 'TaskA' RecurringPeriodicWindows 1 Custom 2015/01/01_00:00:00 2015/01/03_00:00:00 PerPeriod 2 0 2015/01/01_00:00:00 600 '' 0